home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_perl.idb / usr / freeware / catman / p_man / cat3 / ExtUtils::Manifest.Z / ExtUtils::Manifest
Encoding:
Text File  |  1998-10-28  |  7.0 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt2222((((33333333////))))JJJJuuuullll////99998888    ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhhEEEExxxx0000tttt2222UUUU))))ttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       ExtUtils::Manifest - utilities to write and check a MANIFEST
  10.       file
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       require ExtUtils::Manifest;
  14.  
  15.       ExtUtils::Manifest::mkmanifest;
  16.  
  17.       ExtUtils::Manifest::manicheck;
  18.  
  19.       ExtUtils::Manifest::filecheck;
  20.  
  21.       ExtUtils::Manifest::fullcheck;
  22.  
  23.       ExtUtils::Manifest::skipcheck;
  24.  
  25.       ExtUtild::Manifest::manifind();
  26.  
  27.       ExtUtils::Manifest::maniread($file);
  28.  
  29.       ExtUtils::Manifest::manicopy($read,$target,$how);
  30.  
  31.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  32.       _M_k_m_a_n_i_f_e_s_t() writes all files    in and below the current
  33.       directory to a file named in the global variable
  34.       $ExtUtils::Manifest::MANIFEST    (which defaults    to MANIFEST)
  35.       in the current directory. It works similar to
  36.  
  37.           find . -print
  38.  
  39.       but in doing so checks each line in an existing MANIFEST
  40.       file and includes any    comments that are found    in the
  41.       existing MANIFEST file in the    new one. Anything between
  42.       white    space and an end of line within    a MANIFEST file    is
  43.       considered to    be a comment. Filenames    and comments are
  44.       seperated by one or more TAB characters in the output. All
  45.       files    that match any regular expression in a file
  46.       MANIFEST.SKIP    (if such a file    exists)    are ignored.
  47.  
  48.       _M_a_n_i_c_h_e_c_k() checks if    all the    files within a MANIFEST    in the
  49.       current directory really do exist. It    only reports
  50.       discrepancies    and exits silently if MANIFEST and the tree
  51.       below    the current directory are in sync.
  52.  
  53.       _F_i_l_e_c_h_e_c_k() finds files below    the current directory that are
  54.       not mentioned    in the MANIFEST    file. An optional file
  55.       MANIFEST.SKIP    will be    consulted. Any file matching a regular
  56.       expression in    such a file will not be    reported as missing in
  57.       the MANIFEST file.
  58.  
  59.       _F_u_l_l_c_h_e_c_k() does both    a _m_a_n_i_c_h_e_c_k() and a _f_i_l_e_c_h_e_c_k().
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 10/23/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt2222((((33333333////))))JJJJuuuullll////99998888    ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhhEEEExxxx0000tttt2222UUUU))))ttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))
  71.  
  72.  
  73.  
  74.       _S_k_i_p_c_h_e_c_k() lists all    the files that are skipped due to your
  75.       MANIFEST.SKIP    file.
  76.  
  77.       _M_a_n_i_f_i_n_d() retruns a hash reference. The keys    of the hash
  78.       are the files    found below the    current    directory.
  79.  
  80.       _M_a_n_i_r_e_a_d($file) reads    a named    MANIFEST file (defaults    to
  81.       MANIFEST in the current directory) and returns a HASH
  82.       reference with files being the keys and comments being the
  83.       values of the    HASH.  Blank lines and lines which start with
  84.       # in the MANIFEST file are discarded.
  85.  
  86.       _M_a_n_i_c_o_p_y($_r_e_a_d,$_t_a_r_g_e_t,$_h_o_w) copies the files    that are the
  87.       keys in the HASH %$_r_e_a_d to the named target directory. The
  88.       HASH reference $_r_e_a_d is typically returned by    the _m_a_n_i_r_e_a_d()
  89.       function. This function is useful for    producing a directory
  90.       tree identical to the    intended distribution tree. The    third
  91.       parameter $how can be    used to    specify    a different methods of
  92.       "copying". Valid values are cp, which    actually copies    the
  93.       files, ln which creates hard links, and best which mostly
  94.       links    the files but copies any symbolic link to make a tree
  95.       without any symbolic link. Best is the default.
  96.  
  97.      MMMMAAAANNNNIIIIFFFFEEEESSSSTTTT....SSSSKKKKIIIIPPPP
  98.       The file MANIFEST.SKIP may contain regular expressions of
  99.       files    that should be ignored by _m_k_m_a_n_i_f_e_s_t() and
  100.       _f_i_l_e_c_h_e_c_k(). The regular expressions should appear one on
  101.       each line. Blank lines and lines which start with # are
  102.       skipped.  Use    \# if you need a regular expression to start
  103.       with a sharp character. A typical example:
  104.  
  105.           \bRCS\b
  106.           ^MANIFEST\.
  107.           ^Makefile$
  108.           ~$
  109.           \.html$
  110.           \.old$
  111.           ^blib/
  112.           ^MakeMaker-\d
  113.  
  114.  
  115.      EEEEXXXXPPPPOOOORRRRTTTT____OOOOKKKK
  116.       &mkmanifest, &manicheck, &filecheck, &fullcheck, &maniread,
  117.       and &manicopy    are exportable.
  118.  
  119.      GGGGLLLLOOOOBBBBAAAALLLL VVVVAAAARRRRIIIIAAAABBBBLLLLEEEESSSS
  120.       $ExtUtils::Manifest::MANIFEST    defaults to MANIFEST. Changing
  121.       it results in    both a different MANIFEST and a    different
  122.       MANIFEST.SKIP    file. This is useful if    you want to maintain
  123.       different distributions for different    audiences (say a user
  124.       version and a    developer version including RCS).
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 10/23/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt2222((((33333333////))))JJJJuuuullll////99998888    ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhhEEEExxxx0000tttt2222UUUU))))ttttiiiillllssss::::::::MMMMaaaannnniiiiffffeeeesssstttt((((3333))))
  137.  
  138.  
  139.  
  140.       $ExtUtils::Manifest::Quiet defaults to 0. If set to a    true
  141.       value, all functions act silently.
  142.  
  143.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  144.       All diagnostic output    is sent    to STDERR.
  145.  
  146.       Not in MANIFEST: _f_i_l_e
  147.            is reported if a    file is    found, that is missing in the
  148.            MANIFEST    file which is excluded by a regular expression
  149.            in the file MANIFEST.SKIP.
  150.  
  151.       No such file:    _f_i_l_e
  152.            is reported if a    file mentioned in a MANIFEST file does
  153.            not exist.
  154.  
  155.       MANIFEST: $!
  156.            is reported if MANIFEST could not be opened.
  157.  
  158.       Added    to MANIFEST: _f_i_l_e
  159.            is reported by _m_k_m_a_n_i_f_e_s_t() if $Verbose is set and a
  160.            file is added to    MANIFEST. $Verbose is set to 1 by
  161.            default.
  162.  
  163.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  164.       the _E_x_t_U_t_i_l_s::_M_a_k_e_M_a_k_e_r manpage which    has handy targets for
  165.       most of the functionality.
  166.  
  167.      AAAAUUUUTTTTHHHHOOOORRRR
  168.       Andreas Koenig <_k_o_e_n_i_g@_f_r_a_n_z._w_w._T_U-_B_e_r_l_i_n._D_E>
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 10/23/98)
  196.  
  197.  
  198.  
  199.